﻿using System.Collections.Generic;
using Stimulus360.Models.Data.CustomTypes;

namespace Stimulus360.Services.Interfaces
{
    /// <summary>
    ///     This interface interacts with IAnalyticsRepository for retrieving analytics information
    ///     to be shown in the graphs
    /// </summary>
    public interface IAnalyticsService
    {
        /// <summary>
        ///     Method to retrieve the Budget , Spend and Job Count details for the top N 
        ///     investment categories
        /// </summary>
        /// <param name="top">
        ///     The No of categories to be considered
        /// </param>
        /// <returns>
        ///     The Budget , Spend and Job Count details for the top N 
        ///     investment categories
        /// </returns>
        /// <remarks>
        ///     All parameters have been taken in string format to enable REST calls in the future
        /// </remarks>
        ICollection<BudgetSpendSummary> GetTopNBudgetSpendSummaries(string top);

        /// <summary>
        ///     Method to retrieve the Idea trend for the current financial year
        /// </summary>
        /// <returns>
        ///     The Idea trend for the current financial year
        /// </returns>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate",
            Justification = "Method use is appropriate considering complexity and logic http://msdn.microsoft.com/en-us/library/bzwdh01d(VS.71).aspx#cpconpropertyusageguidelinesanchor1")]
        ICollection<IdeaTrend> GetIdeationTrend();

        /// <summary>
        ///     Method to retrieve the Project trend for the current financial year
        /// </summary>
        /// <returns>
        ///     The Project  trend for the current financial year
        /// </returns>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate",
            Justification = "Method use is appropriate considering complexity and logic http://msdn.microsoft.com/en-us/library/bzwdh01d(VS.71).aspx#cpconpropertyusageguidelinesanchor1")]
        ICollection<ProjectTrend> GetProjectTrend();

        /// <summary>
        ///     Method to get the Summary to be displayed on the home view.
        /// </summary>
        /// <returns>
        ///     The HomeView Summary
        /// </returns>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate",
            Justification = "Method use is appropriate considering complexity and logic http://msdn.microsoft.com/en-us/library/bzwdh01d(VS.71).aspx#cpconpropertyusageguidelinesanchor1")]
        HomeViewSummary GetHomeViewSummary();
    }
}
